<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_stream_file</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="basic_socket_streambuf/_basic_socket_streambuf.html" title="basic_socket_streambuf::~basic_socket_streambuf">
<link rel="next" href="basic_stream_file/append.html" title="basic_stream_file::append">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_socket_streambuf/_basic_socket_streambuf.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_stream_file/append.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.basic_stream_file"></a><a class="link" href="basic_stream_file.html" title="basic_stream_file">basic_stream_file</a>
</h3></div></div></div>
<p>
        <a class="indexterm" name="boost_asio.indexterm.basic_stream_file"></a>
      </p>
<p>
        Provides stream-oriented file functionality.
      </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="Executor1.html" title="Executor requirements">Executor</a>&gt;
class basic_stream_file :
  public basic_file&lt; Executor &gt;
</pre>
<h5>
<a name="boost_asio.reference.basic_stream_file.h0"></a>
        <span class="phrase"><a name="boost_asio.reference.basic_stream_file.types"></a></span><a class="link" href="basic_stream_file.html#boost_asio.reference.basic_stream_file.types">Types</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file__rebind_executor.html" title="basic_stream_file::rebind_executor"><span class="bold"><strong>rebind_executor</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Rebinds the file type to another executor.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/executor_type.html" title="basic_stream_file::executor_type"><span class="bold"><strong>executor_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The type of the executor associated with the object.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/flags.html" title="basic_stream_file::flags"><span class="bold"><strong>flags</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  A bitmask type (C++ Std [lib.bitmask.types]).
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/native_handle_type.html" title="basic_stream_file::native_handle_type"><span class="bold"><strong>native_handle_type</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  The native representation of a file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/seek_basis.html" title="basic_stream_file::seek_basis"><span class="bold"><strong>seek_basis</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Basis for seeking in a file.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.basic_stream_file.h1"></a>
        <span class="phrase"><a name="boost_asio.reference.basic_stream_file.member_functions"></a></span><a class="link" href="basic_stream_file.html#boost_asio.reference.basic_stream_file.member_functions">Member
        Functions</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/assign.html" title="basic_stream_file::assign"><span class="bold"><strong>assign</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Assign an existing native file to the file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/async_read_some.html" title="basic_stream_file::async_read_some"><span class="bold"><strong>async_read_some</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Start an asynchronous read.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/async_write_some.html" title="basic_stream_file::async_write_some"><span class="bold"><strong>async_write_some</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Start an asynchronous write.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/basic_stream_file.html" title="basic_stream_file::basic_stream_file"><span class="bold"><strong>basic_stream_file</strong></span></a> <span class="silver">[constructor]</span>
                </p>
              </td>
<td>
                <p>
                  Construct a basic_stream_file without opening it. <br> <span class="silver"> —</span><br>
                  Construct and open a basic_stream_file. <br> <span class="silver"> —</span><br> Construct
                  a basic_stream_file on an existing native file. <br> <span class="silver"> —</span><br> Move-construct
                  a basic_stream_file from another. <br> <span class="silver"> —</span><br> Move-construct
                  a basic_stream_file from a file of another executor type.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/cancel.html" title="basic_stream_file::cancel"><span class="bold"><strong>cancel</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Cancel all asynchronous operations associated with the file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/close.html" title="basic_stream_file::close"><span class="bold"><strong>close</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Close the file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/get_executor.html" title="basic_stream_file::get_executor"><span class="bold"><strong>get_executor</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the executor associated with the object.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/is_open.html" title="basic_stream_file::is_open"><span class="bold"><strong>is_open</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Determine whether the file is open.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/native_handle.html" title="basic_stream_file::native_handle"><span class="bold"><strong>native_handle</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the native file representation.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/open.html" title="basic_stream_file::open"><span class="bold"><strong>open</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Open the file using the specified path.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/operator_eq_.html" title="basic_stream_file::operator="><span class="bold"><strong>operator=</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Move-assign a basic_stream_file from another. <br> <span class="silver"> —</span><br> Move-assign
                  a basic_stream_file from a file of another executor type.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/read_some.html" title="basic_stream_file::read_some"><span class="bold"><strong>read_some</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Read some data from the file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/release.html" title="basic_stream_file::release"><span class="bold"><strong>release</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Release ownership of the underlying native file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/resize.html" title="basic_stream_file::resize"><span class="bold"><strong>resize</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Alter the size of the file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/seek.html" title="basic_stream_file::seek"><span class="bold"><strong>seek</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Seek to a position in the file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/size.html" title="basic_stream_file::size"><span class="bold"><strong>size</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Get the size of the file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/sync_all.html" title="basic_stream_file::sync_all"><span class="bold"><strong>sync_all</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Synchronise the file to disk.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/sync_data.html" title="basic_stream_file::sync_data"><span class="bold"><strong>sync_data</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Synchronise the file data to disk.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/write_some.html" title="basic_stream_file::write_some"><span class="bold"><strong>write_some</strong></span></a>
                </p>
              </td>
<td>
                <p>
                  Write some data to the file.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/_basic_stream_file.html" title="basic_stream_file::~basic_stream_file"><span class="bold"><strong>~basic_stream_file</strong></span></a> <span class="silver">[destructor]</span>
                </p>
              </td>
<td>
                <p>
                  Destroys the file.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<h5>
<a name="boost_asio.reference.basic_stream_file.h2"></a>
        <span class="phrase"><a name="boost_asio.reference.basic_stream_file.data_members"></a></span><a class="link" href="basic_stream_file.html#boost_asio.reference.basic_stream_file.data_members">Data
        Members</a>
      </h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                <p>
                  Name
                </p>
              </th>
<th>
                <p>
                  Description
                </p>
              </th>
</tr></thead>
<tbody>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/append.html" title="basic_stream_file::append"><span class="bold"><strong>append</strong></span></a> <span class="silver">[static]</span>
                </p>
              </td>
<td>
                <p>
                  Open the file in append mode.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/create.html" title="basic_stream_file::create"><span class="bold"><strong>create</strong></span></a> <span class="silver">[static]</span>
                </p>
              </td>
<td>
                <p>
                  Create the file if it does not exist.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/exclusive.html" title="basic_stream_file::exclusive"><span class="bold"><strong>exclusive</strong></span></a> <span class="silver">[static]</span>
                </p>
              </td>
<td>
                <p>
                  Ensure a new file is created. Must be combined with create.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/read_only.html" title="basic_stream_file::read_only"><span class="bold"><strong>read_only</strong></span></a> <span class="silver">[static]</span>
                </p>
              </td>
<td>
                <p>
                  Open the file for reading.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/read_write.html" title="basic_stream_file::read_write"><span class="bold"><strong>read_write</strong></span></a> <span class="silver">[static]</span>
                </p>
              </td>
<td>
                <p>
                  Open the file for reading and writing.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/truncate.html" title="basic_stream_file::truncate"><span class="bold"><strong>truncate</strong></span></a> <span class="silver">[static]</span>
                </p>
              </td>
<td>
                <p>
                  Open the file with any existing contents truncated.
                </p>
              </td>
</tr>
<tr>
<td>
                <p>
                  <a class="link" href="basic_stream_file/write_only.html" title="basic_stream_file::write_only"><span class="bold"><strong>write_only</strong></span></a> <span class="silver">[static]</span>
                </p>
              </td>
<td>
                <p>
                  Open the file for writing.
                </p>
              </td>
</tr>
</tbody>
</table></div>
<p>
        The <a class="link" href="basic_stream_file.html" title="basic_stream_file"><code class="computeroutput">basic_stream_file</code></a>
        class template provides asynchronous and blocking stream-oriented file functionality.
      </p>
<h5>
<a name="boost_asio.reference.basic_stream_file.h3"></a>
        <span class="phrase"><a name="boost_asio.reference.basic_stream_file.thread_safety"></a></span><a class="link" href="basic_stream_file.html#boost_asio.reference.basic_stream_file.thread_safety">Thread Safety</a>
      </h5>
<p>
        <span class="emphasis"><em>Distinct</em></span> <span class="emphasis"><em>objects:</em></span> Safe.
      </p>
<p>
        <span class="emphasis"><em>Shared</em></span> <span class="emphasis"><em>objects:</em></span> Unsafe.
      </p>
<h5>
<a name="boost_asio.reference.basic_stream_file.h4"></a>
        <span class="phrase"><a name="boost_asio.reference.basic_stream_file.requirements"></a></span><a class="link" href="basic_stream_file.html#boost_asio.reference.basic_stream_file.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_stream_file.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2021 Christopher
      M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_socket_streambuf/_basic_socket_streambuf.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_stream_file/append.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
